<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class router_advertisement</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="ODTONE 0.4">
<link rel="up" href="../icmp.html#idp20291344" title="Description">
<link rel="prev" href="neighbor_solicitation.html" title="Class neighbor_solicitation">
<link rel="next" href="router_solicitation.html" title="Class router_solicitation">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="'ODTONE - Open Dot Twenty One'" width="100" height="100" src="../../../.././images/logo.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="neighbor_solicitation.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../icmp.html#idp20291344"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="router_solicitation.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="odtone.net.ip.icmp.router_advertisement"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class router_advertisement</span></h2>
<p>odtone::net::ip::icmp::router_advertisement</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../../odtone_net_library.html#header..home.carlos.Projectos.odtone.inc.odtone.net.ip.icmp.icmp_hpp" title="Header &lt;/home/carlos/Projectos/odtone/inc/odtone/net/ip/icmp/icmp.hpp&gt;">/home/carlos/Projectos/odtone/inc/odtone/net/ip/icmp/icmp.hpp</a>&gt;

</span>

<span class="keyword">class</span> <a class="link" href="router_advertisement.html" title="Class router_advertisement">router_advertisement</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">odtone</span><span class="special">::</span><span class="identifier">net</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">icmp</span><span class="special">::</span><span class="identifier">header</span> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="router_advertisement.html#odtone.net.ip.icmp.router_advertisementconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="router_advertisement.html#idp5006912-bb"><span class="identifier">router_advertisement</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="router_advertisement.html#idp4991496-bb">public member functions</a></span>
  <span class="identifier">uint8</span> <a class="link" href="router_advertisement.html#idp4991680-bb"><span class="identifier">current_hop_limit</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="router_advertisement.html#idp4992784-bb"><span class="identifier">M</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="router_advertisement.html#idp4993904-bb"><span class="identifier">O</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">uint16</span> <a class="link" href="router_advertisement.html#idp4995008-bb"><span class="identifier">lifetime</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">uint32</span> <a class="link" href="router_advertisement.html#idp4996056-bb"><span class="identifier">reachable_time</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">uint32</span> <a class="link" href="router_advertisement.html#idp4997152-bb"><span class="identifier">retrans_timer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="router_advertisement.html#idp4998264-bb"><span class="identifier">current_hop_limit</span></a><span class="special">(</span><span class="identifier">uint8</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="router_advertisement.html#idp4999712-bb"><span class="identifier">M</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="router_advertisement.html#idp5001176-bb"><span class="identifier">O</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="router_advertisement.html#idp5002624-bb"><span class="identifier">lifetime</span></a><span class="special">(</span><span class="identifier">uint16</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="router_advertisement.html#idp5004016-bb"><span class="identifier">reachable_time</span></a><span class="special">(</span><span class="identifier">uint32</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="router_advertisement.html#idp5005456-bb"><span class="identifier">retrans_timer</span></a><span class="special">(</span><span class="identifier">uint32</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="router_advertisement.html#odtone.net.ip.icmp.router_advertisementpublic-data-members">public data members</a></span>
  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">uint8</span> <a class="link" href="router_advertisement.html#odtone.net.ip.icmp.router_advertisement.type_value"><span class="identifier">type_value</span></a><span class="special">;</span>
  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">uint8</span> <a class="link" href="router_advertisement.html#odtone.net.ip.icmp.router_advertisement.code_value"><span class="identifier">code_value</span></a><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp20576360"></a><h2>Description</h2>
<p>This class represents an ICMP Router Advertisement packet. </p>
<div class="refsect2">
<a name="idp20576760"></a><h3>
<a name="odtone.net.ip.icmp.router_advertisementconstruct-copy-destruct"></a><code class="computeroutput">router_advertisement</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><a name="idp5006912-bb"></a><span class="identifier">router_advertisement</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Construct an empty ICMP Router Advertisement packet. </p>
</li></ol></div>
</div>
<div class="refsect2">
<a name="idp20580080"></a><h3>
<a name="idp4991496-bb"></a><code class="computeroutput">router_advertisement</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">uint8</span> <a name="idp4991680-bb"></a><span class="identifier">current_hop_limit</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the Current Hop Limit field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The Current Hop Limit field value. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp4992784-bb"></a><span class="identifier">M</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the Managed Address Configuration flag value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The Managed Address Configuration flag value. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp4993904-bb"></a><span class="identifier">O</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the Other Configuration flag value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The Other Configuration flag value. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">uint16</span> <a name="idp4995008-bb"></a><span class="identifier">lifetime</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the Lifetime field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The Lifetime field value. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">uint32</span> <a name="idp4996056-bb"></a><span class="identifier">reachable_time</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the Reachable Time field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The Reachable Time field value. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">uint32</span> <a name="idp4997152-bb"></a><span class="identifier">retrans_timer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the Retransmission Timer field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The Retransmission Timer field value. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp4998264-bb"></a><span class="identifier">current_hop_limit</span><span class="special">(</span><span class="identifier">uint8</span> val<span class="special">)</span><span class="special">;</span></pre>
<p>Set the Current Hop Limit field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">val</code></span></p></td>
<td><p>The Current Hop Limit field value. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp4999712-bb"></a><span class="identifier">M</span><span class="special">(</span><span class="keyword">bool</span> val<span class="special">)</span><span class="special">;</span></pre>
<p>Set the Managed Address Configuration flag value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">val</code></span></p></td>
<td><p>The Managed Address Configuration flag value. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5001176-bb"></a><span class="identifier">O</span><span class="special">(</span><span class="keyword">bool</span> val<span class="special">)</span><span class="special">;</span></pre>
<p>Set the Other Configuration flag value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">val</code></span></p></td>
<td><p>The Other Configuration flag value. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5002624-bb"></a><span class="identifier">lifetime</span><span class="special">(</span><span class="identifier">uint16</span> val<span class="special">)</span><span class="special">;</span></pre>
<p>Set the Lifetime field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">val</code></span></p></td>
<td><p>The Lifetime field value. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5004016-bb"></a><span class="identifier">reachable_time</span><span class="special">(</span><span class="identifier">uint32</span> val<span class="special">)</span><span class="special">;</span></pre>
<p>Set the Reachable Time field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">val</code></span></p></td>
<td><p>The Reachable Time field value. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5005456-bb"></a><span class="identifier">retrans_timer</span><span class="special">(</span><span class="identifier">uint32</span> val<span class="special">)</span><span class="special">;</span></pre>
<p>Set the Retransmission Timer field value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">val</code></span></p></td>
<td><p>The Retransmission Timer field value. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp20628728"></a><h3>
<a name="odtone.net.ip.icmp.router_advertisementpublic-data-members"></a><code class="computeroutput">router_advertisement</code> 
        public
       public data members</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">uint8</span> <a name="odtone.net.ip.icmp.router_advertisement.type_value"></a><span class="identifier">type_value</span><span class="special">;</span></pre>
<p>ICMP Router Advertisement type. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">uint8</span> <a name="odtone.net.ip.icmp.router_advertisement.code_value"></a><span class="identifier">code_value</span><span class="special">;</span></pre>
<p>ICMP Router Advertisement code. </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2012 Universidade
      Aveiro<br>Copyright &#169; 2009-2012 Instituto
      de Telecomunica&#231;&#245;es - P&#243;lo Aveiro<p>
        This software is distributed under a license. The full license agreement
        can be found in the LICENSE in this distribution. This software may not be
        copied, modified, sold or distributed other than expressed in the named license
        agreement. This software is distributed without any warranty.
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="neighbor_solicitation.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../icmp.html#idp20291344"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="router_solicitation.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
